AEC Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the Acoustic Echo Cancelation (AEC) parameters used for processing recorded audio.
Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Tasks
-
enableAECpropertySpecifies if AEC will be enabled during concurrent audio recording and audio playback. Default:
"true". The value can be set at runtime using the"enableAECRuntime"property.Parameter is optional.
-
enableAECRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enableAEC"property. Example:"$[EnableAEC]".Parameter is optional.
-
delayOffsetMspropertySpecifies delay offset duration window in milliseconds during which AEC will cancel the delayed echo of an audio playback successfully. Default: 0. Range is 0-100. The value can be set at runtime using the
"delayOffsetMsRuntime"property.Parameter is optional.
-
delayOffsetMsRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"delayOffsetMs"property. Example:"$[DelayOffsetMs]".Parameter is optional.
-
aecMobilepropertySpecifies if AEC for mobile device should be used. Default:
"false". The value can be set at runtime using the"aecMobileRuntime"property.Parameter is optional.
-
aecMobileRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"aecMobile"property. Example:"$[AECMobile]".Parameter is optional.
-
aecMobileModepropertySpecifies AEC mobile mode if
"aecMobile"is"true". Values: 0 (quiet ear piece or headset), 1 (ear piece), 2 (loud ear piece), 3 (speaker phone) or 4 (loud speaker phone). Default: 3. The value can be set at runtime using the"aecMobileModeRuntime"property.Parameter is optional.
-
aecMobileModeRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"aecMobileMode"property. Example:"$[AECMobileMode]".Parameter is optional.
-
enableAECMobileComfortNoisepropertySpecifies that comfort noise replaces suppressed background noise to maintain a consistent signal level. Default:
"true". The value can be set at runtime using the"enableAECMobileComfortNoiseRuntime"property.Parameter is optional.
-
enableAECMobileComfortNoiseRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enableAECMobileComfortNoise"property. Example:"$[EnableAECMobileComfortNoise]".Parameter is optional.
-
enableDriftCompensationpropertySpecifies if drift compensation to be enabled. Default:
"false". The value can be set at runtime using the"enableDriftCompensationRuntime"property.Parameter is optional.
-
enableDriftCompensationRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enableDriftCompensation"property. Example:"$[EnableDriftCompensation]".Parameter is optional.
-
enableAECCoreDataDumppropertySpecifies if all AEC Core Data is to be dumped into files. Default:
"false". The value can be set at runtime using the"enableAECCoreDataDumpRuntime"property.Parameter is optional.
-
enableAECCoreDataDumpRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enableAECCoreDataDump"property. Example:"$[EnableAECCoreDataDump]".Parameter is optional.
-
enableECDataDumppropertySpecifies if all Echo Canceler Data is to be dumped into files. Default:
"false". The value can be set at runtime using the"enableECDataDumpRuntime"property.Parameter is optional.
-
enableECDataDumpRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enableECDataDump"property. Example:"$[EnableECDataDump]".Parameter is optional.
-
enableAECLevelEstimatorpropertySpecifies if AEC level estimator is to be enabled. Default:
"false". Set to"true"to receive AEC statistics using media event notifications to Client. The value can be set at runtime using the"enableAECLevelEstimatorRuntime"property.Parameter is optional.
-
enableAECLevelEstimatorRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"enableAECLevelEstimator"property. Example:"$[EnableAECLevelEstimator]".Parameter is optional.
Properties
aecMobile
"aecMobile": boolean
Discussion
Specifies if AEC for mobile device should be used. Default: "false". The value can be set at runtime using the "aecMobileRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
aecMobileMode
"aecMobileMode": integer
Discussion
Specifies AEC mobile mode if "aecMobile" is "true". Values: 0 (quiet ear piece or headset), 1 (ear piece), 2 (loud ear piece), 3 (speaker phone) or 4 (loud speaker phone). Default: 3. The value can be set at runtime using the "aecMobileModeRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
aecMobileModeRuntime
"aecMobileModeRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "aecMobileMode" property. Example: "$[AECMobileMode]".
Parameter is optional.
Declared In
Voiceflow.schema.json
aecMobileRuntime
"aecMobileRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "aecMobile" property. Example: "$[AECMobile]".
Parameter is optional.
Declared In
Voiceflow.schema.json
delayOffsetMs
"delayOffsetMs": integer
Discussion
Specifies delay offset duration window in milliseconds during which AEC will cancel the delayed echo of an audio playback successfully. Default: 0. Range is 0-100. The value can be set at runtime using the "delayOffsetMsRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
delayOffsetMsRuntime
"delayOffsetMsRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "delayOffsetMs" property. Example: "$[DelayOffsetMs]".
Parameter is optional.
Declared In
Voiceflow.schema.json
enableAEC
"enableAEC": boolean
Discussion
Specifies if AEC will be enabled during concurrent audio recording and audio playback. Default: "true". The value can be set at runtime using the "enableAECRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableAECCoreDataDump
"enableAECCoreDataDump": boolean
Discussion
Specifies if all AEC Core Data is to be dumped into files. Default: "false". The value can be set at runtime using the "enableAECCoreDataDumpRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableAECCoreDataDumpRuntime
"enableAECCoreDataDumpRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enableAECCoreDataDump" property. Example: "$[EnableAECCoreDataDump]".
Parameter is optional.
Declared In
Voiceflow.schema.json
enableAECLevelEstimator
"enableAECLevelEstimator": boolean
Discussion
Specifies if AEC level estimator is to be enabled. Default: "false". Set to "true" to receive AEC statistics using media event notifications to Client. The value can be set at runtime using the "enableAECLevelEstimatorRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableAECLevelEstimatorRuntime
"enableAECLevelEstimatorRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enableAECLevelEstimator" property. Example: "$[EnableAECLevelEstimator]".
Parameter is optional.
Declared In
Voiceflow.schema.json
enableAECMobileComfortNoise
"enableAECMobileComfortNoise": boolean
Discussion
Specifies that comfort noise replaces suppressed background noise to maintain a consistent signal level. Default: "true". The value can be set at runtime using the "enableAECMobileComfortNoiseRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableAECMobileComfortNoiseRuntime
"enableAECMobileComfortNoiseRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enableAECMobileComfortNoise" property. Example: "$[EnableAECMobileComfortNoise]".
Parameter is optional.
Declared In
Voiceflow.schema.json
enableAECRuntime
"enableAECRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enableAEC" property. Example: "$[EnableAEC]".
Parameter is optional.
Declared In
Voiceflow.schema.json
enableDriftCompensation
"enableDriftCompensation": boolean
Discussion
Specifies if drift compensation to be enabled. Default: "false". The value can be set at runtime using the "enableDriftCompensationRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableDriftCompensationRuntime
"enableDriftCompensationRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enableDriftCompensation" property. Example: "$[EnableDriftCompensation]".
Parameter is optional.
Declared In
Voiceflow.schema.json
enableECDataDump
"enableECDataDump": boolean
Discussion
Specifies if all Echo Canceler Data is to be dumped into files. Default: "false". The value can be set at runtime using the "enableECDataDumpRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
enableECDataDumpRuntime
"enableECDataDumpRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "enableECDataDump" property. Example: "$[EnableECDataDump]".
Parameter is optional.
Declared In
Voiceflow.schema.json